Skip to content

Multiple openapi @dataExamples#224

Merged
kubukoz merged 2 commits intodisneystreaming:mainfrom
msosnicki:multiple-data-examples
Aug 7, 2025
Merged

Multiple openapi @dataExamples#224
kubukoz merged 2 commits intodisneystreaming:mainfrom
msosnicki:multiple-data-examples

Conversation

@msosnicki
Copy link
Contributor

@msosnicki msosnicki commented Jun 13, 2025

This is how it looks like after the change

Screenshot from 2025-06-12 15-07-04

@@ -1,699 +1,711 @@
{
Copy link
Contributor Author

@msosnicki msosnicki Jun 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is unfortunate that this change is counted like that in git. VSCode is doing a better job visualizing the differences, by hiding unrelevant lines
Screenshot from 2025-06-13 08-46-35

@msosnicki msosnicki marked this pull request as ready for review June 13, 2025 06:58
@CLAassistant
Copy link

CLAassistant commented Jun 16, 2025

CLA assistant check
All committers have signed the CLA.

@msosnicki msosnicki requested a review from kubukoz June 16, 2025 11:38
Copy link
Member

@kubukoz kubukoz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

mostly lgtm, just some nitpicks

@kubukoz
Copy link
Member

kubukoz commented Jun 16, 2025

This is how it looks like after the change

Screenshot from 2025-06-12 15-07-04

now that I'm looking at this up close, that doesn't seem right. It makes it seem Examples is a field...

from what I can see editor.swagger.io doesn't support OpenAPI 3.1:

image

The "old" example looks fine:

image

but with multiples, the best I can get is the same you got:

image

It seems confusing / misleading on Swagger UI's side :/

@msosnicki
Copy link
Contributor Author

Raised issue swagger-api/swagger-ui#10503

@kubukoz
Copy link
Member

kubukoz commented Jul 3, 2025

I assume Swagger will take its while to acknowledge and/or implement this. For now, let's hide it behind a configuration option (in addition to the OpenAPI 3.1 gate we already have) and move on

@msosnicki
Copy link
Contributor Author

I assume Swagger will take its while to acknowledge and/or implement this. For now, let's hide it behind a configuration option (in addition to the OpenAPI 3.1 gate we already have) and move on

We don't control OpenApiConfig unfortunately, it is coming from smithy-openapi module

@kubukoz
Copy link
Member

kubukoz commented Jul 8, 2025

I hoped there was a mechanism to put arbitrary properties in it :(

contribution idea for smithy-openapi?

@msosnicki
Copy link
Contributor Author

I hoped there was a mechanism to put arbitrary properties in it :(

contribution idea for smithy-openapi?

Related smithy PR smithy-lang/smithy#2705

@kubukoz
Copy link
Member

kubukoz commented Aug 6, 2025

okay... what happened here?

image

I don't see it locally. Maybe the runner state got corrupted... let me reopen in a fresh branch to purge it

@kubukoz
Copy link
Member

kubukoz commented Aug 7, 2025

not my proudest moment... I only today realized we were behind main, that's why it passed locally... 🤦

@kubukoz kubukoz force-pushed the multiple-data-examples branch from 5404f05 to d8fd9cf Compare August 7, 2025 17:04
@kubukoz kubukoz merged commit 824089b into disneystreaming:main Aug 7, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants